Dashboard Parameters

Dashboard parameters are very similar to other Clarity parameters, and are used in much the same way. Parameter definitions are stored in a CLS file and retrieved at runtime to produce the report. The parameter values are stored against a Dashboard view setup.

Basically, parameters in the Dashboard work like this:

Note: Some errors are suppressed in the dashboard, and it could be irritating to have messages or parameter windows popping up each time the dashboard refreshes – so when designing your own dashboard reports, rather than giving an error if the correct parameters are not supplied it is smarter to use some sensible default values and continue running the report.

Adding New Parameters

You add parameters to a dashboard report the same way you do any other type of report. Go to Clarity's Tools > Runtime Parameters menu (consult the Clarity documentation for further details on setting up parameters).

Setting Parameter Values

Once parameters are set up in the dashboard report, the parameter values can be set in the dashboard setup screen:

 

Click the Parameter button to open the parameter window:

 

Notice that parameter defaults are shown if there are not already parameter values assigned to this dashboard; otherwise the previously selected parameter values are shown. Select the desired values and click Save. Notice how the parameters are added after the report (CLR) name in the Report Settings field, using the same format as regular command-line parameter values.